home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmQTcontainerItem.z / XmQTcontainerItem
Text File  |  1998-10-30  |  17KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmQQQQTTTTccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmm((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmQQQQTTTTccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmm((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           _X_m_Q_T_c_o_n_t_a_i_n_e_r_I_t_e_m - A widget holding this trait can serve as
  10.           a child of a widget holding the XmQTcontainer trait
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/ContItemT.h>
  14.  
  15.           typedef struct {
  16.                     Mask            valueMask;
  17.                     unsigned char   view_type;
  18.                     unsigned char   visual_emphasis;
  19.                     Dimension       icon_width;
  20.                     Cardinal        detail_count;
  21.           } XmContainerItemDataRec, *XmContainerItemData;
  22.  
  23.           typedef struct {
  24.                     int                             version;
  25.                     XmContainerItemSetValuesProc    setValues;
  26.                     XmContainerItemGetValuesProc    getValues;
  27.           } XmContainerItemTraitRec, *XmContainerItemTrait;
  28.           vvvvooooiiiidddd ((((****XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmSSSSeeeettttVVVVaaaalllluuuueeeessssPPPPrrrroooocccc))))(
  29.           WWWWiiiiddddggggeeeetttt,
  30.           XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmDDDDaaaattttaaaa,
  31.           vvvvooooiiiidddd ((((****XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmGGGGeeeettttVVVVaaaalllluuuueeeessssPPPPrrrroooocccc))))(
  32.           WWWWiiiiddddggggeeeetttt,
  33.           XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmDDDDaaaattttaaaa);
  34.  
  35.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  36.           This page documents Motif 2.1.
  37.  
  38.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  39.           A widget holding the _X_m_Q_T_c_o_n_t_a_i_n_e_r_I_t_e_m trait can serve as a
  40.           child to a widget holding the _X_m_Q_T_c_o_n_t_a_i_n_e_r trait.
  41.  
  42.           XXXXmmmmIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt is the only standard Motif class holding the
  43.           _X_m_Q_T_c_o_n_t_a_i_n_e_r_I_t_e_m trait.  XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrr is the only standard
  44.           Motif widget that examines its children for this trait.
  45.  
  46.         TTTThhhheeee sssseeeettttVVVVaaaalllluuuueeeessss TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
  47.           vvvvooooiiiidddd sssseeeettttVVVVaaaalllluuuueeeessss(
  48.           WWWWiiiiddddggggeeeetttt ccccoooonnnnttttaaaaiiiinnnneeeerrrrCCCChhhhiiiillllddddWWWWiiiiddddggggeeeetttt,
  49.           XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmDDDDaaaattttaaaa ccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmDDDDaaaattttaaaa);
  50.  
  51.           A container widget (such as XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrr) calls the sssseeeettttVVVVaaaalllluuuueeeessss
  52.           trait method of its _c_o_n_t_a_i_n_e_r_C_h_i_l_d_W_i_d_g_e_tin order to set
  53.           certain visual properties.
  54.  
  55.           _c_o_n_t_a_i_n_e_r_C_h_i_l_d_W_i_d_g_e_t
  56.                     Specifies the container child widget that is
  57.                     holding this trait.
  58.  
  59.           _c_o_n_t_a_i_n_e_r_I_t_e_m_D_a_t_a
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmQQQQTTTTccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmm((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmQQQQTTTTccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmm((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     Specifies an XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmDDDDaaaattttaaaa structure.  This
  75.                     structure holds five fields, but only the first
  76.                     three fields are meaningful to the sssseeeettttVVVVaaaalllluuuueeeessss trait
  77.                     method.  Following is a description of those three
  78.                     fields:
  79.  
  80.                     _v_a_l_u_e_M_a_s_k Specifies a bit mask. Each bit in the
  81.                               bit mask symbolizes a visual property
  82.                               affected by the sssseeeettttVVVVaaaalllluuuueeeessss trait method.
  83.                               If a particular bit is set to 1,
  84.                               sssseeeettttVVVVaaaalllluuuueeeessss modifies the associated visual
  85.                               property.  If this same bit holds a 0,
  86.                               sssseeeettttVVVVaaaalllluuuueeeessss does not modify the associated
  87.                               visual property.  To help you set bits,
  88.                               the CCCCoooonnnnttttIIIItttteeeemmmmTTTT....hhhh header file provides
  89.                               three relevant constants.
  90.  
  91.                               CCCCoooonnnnttttIIIItttteeeemmmmVVVViiiieeeewwwwTTTTyyyyppppeeee
  92.                                         Sets the _v_i_e_w__t_y_p_e visual
  93.                                         property bit to 1.
  94.  
  95.                               CCCCoooonnnnttttIIIItttteeeemmmmVVVViiiissssuuuuaaaallllEEEEmmmmpppphhhhaaaassssiiiissss
  96.                                         Sets the sssseeeettttVVVVaaaalllluuuueeeessss visual
  97.                                         property bit to 1.
  98.  
  99.                               CCCCoooonnnnttttIIIItttteeeemmmmAAAAllllllllVVVVaaaalllliiiidddd
  100.                                         Sets both visual property bits
  101.                                         to 1.
  102.  
  103.                     _v_i_e_w__t_y_p_e Specifies the view type of _w_i_d_g_e_t.  For
  104.                               example, when XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrr calls
  105.                               sssseeeettttVVVVaaaalllluuuueeeessss, it passes a _v_i_e_w__t_y_p_e value
  106.                               of either XXXXmmmmLLLLAAAARRRRGGGGEEEE____IIIICCCCOOOONNNN or XXXXmmmmSSSSMMMMAAAALLLLLLLL____IIIICCCCOOOONNNN.
  107.                               (See the XXXXmmmmIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt(3) reference page
  108.                               for a description of XXXXmmmmLLLLAAAARRRRGGGGEEEE____IIIICCCCOOOONNNN and
  109.                               XXXXmmmmSSSSMMMMAAAALLLLLLLL____IIIICCCCOOOONNNN.)
  110.  
  111.                     _v_i_s_u_a_l__e_m_p_h_a_s_i_s
  112.                               Specifies the visual emphasis of _w_i_d_g_e_t.
  113.                               For example, when XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrr calls
  114.                               sssseeeettttVVVVaaaalllluuuueeeessss, it passes a _v_i_s_u_a_l_E_m_p_h_a_s_i_s
  115.                               value of either XXXXmmmmSSSSEEEELLLLEEEECCCCTTTTEEEEDDDD or
  116.                               XXXXmmmmNNNNOOOOTTTT____SSSSEEEELLLLEEEECCCCTTTTEEEEDDDD.  See the XXXXmmmmIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt(3)
  117.                               reference page for a description of
  118.                               XXXXmmmmSSSSEEEELLLLEEEECCCCTTTTEEEEDDDD and XXXXmmmmNNNNOOOOTTTT____SSSSEEEELLLLEEEECCCCTTTTEEEEDDDD.
  119.  
  120.         TTTThhhheeee ggggeeeettttVVVVaaaalllluuuueeeessss TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
  121.           vvvvooooiiiidddd ggggeeeettttVVVVaaaalllluuuueeeessss(
  122.           WWWWiiiiddddggggeeeetttt ccccoooonnnnttttaaaaiiiinnnneeeerrrrCCCChhhhiiiillllddddWWWWiiiiddddggggeeeetttt,
  123.           XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmDDDDaaaattttaaaa ccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmDDDDaaaattttaaaa);
  124.  
  125.           A container widget calls the ggggeeeettttVVVVaaaalllluuuueeeessss trait method of its
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmQQQQTTTTccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmm((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmQQQQTTTTccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmm((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           _c_o_n_t_a_i_n_e_r_C_h_i_l_d_W_i_d_g_e_t to determine what visual properties the
  141.           _c_o_n_t_a_i_n_e_r_C_h_i_l_d_W_i_d_g_e_t provides.
  142.  
  143.           _c_o_n_t_a_i_n_e_r_C_h_i_l_d_W_i_d_g_e_t
  144.                     Specifies the child widget that is holding this
  145.                     trait.
  146.  
  147.           _c_o_n_t_a_i_n_e_r_I_t_e_m_D_a_t_a
  148.                     Specifies an XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmmDDDDaaaattttaaaa structure.  This
  149.                     structure holds the following five fields:
  150.  
  151.                     _v_a_l_u_e_M_a_s_k Specifies a bit mask. Each bit in the
  152.                               bit mask symbolizes a visual property
  153.                               returned by the ggggeeeettttVVVVaaaalllluuuueeeessss trait method.
  154.                               If the caller sets a particular bit to
  155.                               1, ggggeeeettttVVVVaaaalllluuuueeeessss returns meaningful
  156.                               information about the associated visual
  157.                               property.  However, if the caller places
  158.                               a 0 in this same bit, then ggggeeeettttVVVVaaaalllluuuueeeessss
  159.                               does not return meaningful information
  160.                               about the associated visual property. In
  161.                               short, the _v_a_l_u_e_M_a_s_k lets the caller
  162.                               specify the visual properties that it is
  163.                               interested in.  To help you set bits,
  164.                               the CCCCoooonnnnttttIIIItttteeeemmmmTTTT....hhhh header file provides the
  165.                               following five constants:
  166.  
  167.                               CCCCoooonnnnttttIIIItttteeeemmmmVVVViiiieeeewwwwTTTTyyyyppppeeee
  168.                                         Sets the _v_i_e_w__t_y_p_e visual
  169.                                         property bit to 1.
  170.  
  171.                               CCCCoooonnnnttttIIIItttteeeemmmmVVVViiiissssuuuuaaaallllEEEEmmmmpppphhhhaaaassssiiiissss
  172.                                         Sets the _v_i_s_u_a_l__e_m_p_h_a_s_i_s
  173.                                         visual property bit to 1.
  174.  
  175.                               CCCCoooonnnnttttIIIItttteeeemmmmIIIIccccoooonnnnWWWWiiiiddddtttthhhh
  176.                                         Sets the iiiiccccoooonnnn____wwwwiiiiddddtttthhhh visual
  177.                                         property bit to 1.
  178.  
  179.                               CCCCoooonnnnttttIIIItttteeeemmmmDDDDeeeettttaaaaiiiillllCCCCoooouuuunnnntttt
  180.                                         Sets the _d_e_t_a_i_l__c_o_u_n_t visual
  181.                                         property bit to 1.
  182.  
  183.                               CCCCoooonnnnttttIIIItttteeeemmmmAAAAllllllllVVVVaaaalllliiiidddd
  184.                                         Sets all four visual property
  185.                                         bits to 1.
  186.  
  187.                     _v_i_e_w__t_y_p_e Returns the view type of
  188.                               _c_h_i_l_d_C_o_n_t_a_i_n_e_r_W_i_d_g_e_t.  If XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrr is
  189.                               managing _c_o_n_t_a_i_n_e_r_C_h_i_l_d_W_i_d_g_e_t,
  190.                               XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrr expects that the returned
  191.                               value will be either XXXXmmmmLLLLAAAARRRRGGGGEEEE____IIIICCCCOOOONNNN or
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmQQQQTTTTccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmm((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmQQQQTTTTccccoooonnnnttttaaaaiiiinnnneeeerrrrIIIItttteeeemmmm((((3333XXXX))))
  203.  
  204.  
  205.  
  206.                               XXXXmmmmSSSSMMMMAAAALLLLLLLL____IIIICCCCOOOONNNN.  See the XXXXmmmmIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt(3)
  207.                               reference page for a description of
  208.                               these two values.
  209.  
  210.                     _v_i_s_u_a_l__e_m_p_h_a_s_i_s
  211.                               Returns the visual emphasis of
  212.                               _c_h_i_l_d_C_o_n_t_a_i_n_e_r_W_i_d_g_e_t.  If XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrr is
  213.                               managing _w_i_d_g_e_t, XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrr expects
  214.                               that the returned value will be either
  215.                               XXXXmmmmSSSSEEEELLLLEEEECCCCTTTTEEEEDDDD or XXXXmmmmNNNNOOOOTTTT____SSSSEEEELLLLEEEECCCCTTTTEEEEDDDD.  (See the
  216.                               XXXXmmmmIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt(3) reference page for a
  217.                               description of these two values.)
  218.  
  219.                     _i_c_o_n__w_i_d_t_h
  220.                               Returns the width of the icon.  (This
  221.                               width will not include the width of any
  222.                               associated detail strings.)
  223.  
  224.                     _d_e_t_a_i_l__c_o_u_n_t
  225.                               Returns the number of details strings in
  226.                               this container child.
  227.  
  228.      RRRREEEELLLLAAAATTTTEEEEDDDD
  229.           EEEExxxxmmmmGGGGrrrriiiidddd(3), XXXXmmmmCCCCoooonnnnttttaaaaiiiinnnneeeerrrr(3), XXXXmmmmIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt(3), and
  230.           XXXXmmmmQQQQTTTTccccoooonnnnttttaaaaiiiinnnneeeerrrr(3).
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                         (printed 10/24/98)
  262.  
  263.  
  264.  
  265.